[]
检索用户可用的自定义主题列表。
返回值
状态码: 200
成功
状态码: 400
错误的请求
根据提供的模型创建一个新的自定义主题。
请求数据格式
返回值
状态码: 200
成功
CreateUpdateCustomThemeResponseModel
状态码: 400
错误的请求
检索主题构建会话的状态。
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| sessionId必填项 | string | path | 要检查状态的会话的 ID。 |
返回值
状态码: 200
成功
状态码: 400
错误的请求
将自定义主题升级到新版本。
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 需要升级的主题的ID。 |
返回值
状态码: 200
成功
UpgradeCustomThemeResponseModel
状态码: 400
错误的请求
状态码: 404
未找到
将更改保存到现有自定义主题。
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 要保存更改的主题的 ID。 |
请求数据格式
返回值
状态码: 200
成功
CreateUpdateCustomThemeResponseModel
状态码: 400
错误的请求
状态码: 404
未找到
删除由指定 ID 标识的自定义主题。 在尝试删除主题之前，此方法将检查该主题是否存在以及当前是否正在使用中。
参数:
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 要删除的自定义主题的唯一标识符。 |
返回值
状态码: 204
无内容
状态码: 400
错误的请求
状态码: 404
未找到
表示自定义主题的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| list可为空 | CustomThemeItem | 获取或设置自定义主题项列表。 | |
| canEdit | Boolean | 获取或设置一个值，指示用户是否可以编辑主题。 | |
| hashProductionVersion | Boolean | 获取或设置一个值，该值指示是否对生产版本进行哈希处理。 | |
| pluginStyleCacheDirectory可为空 | Array<string> |
获取或设置插件样式缓存目录列表。 |
代表单个自定义主题项。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id可为空 | string | 获取或设置主题的唯一标识符。 | |
| created | ISO DateTime Sting | 获取或设置主题的创建日期。 | |
| pluginVersion可为空 | string | 获取或设置与主题相关的插件版本。 | |
| displayName可为空 | string | 获取或设置主题的显示名称。 | |
| variables | ThemeVariablesViewModel | ||
| outOfDate | Boolean | 获取或设置一个值，指示主题是否过时。 |
表示主题变量的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| dark_theme | Boolean | 获取或初始化一个值，该值指示是否启用了深色主题。 |
|
| accent1可为空 | string | 获取或初始化第一个主题色。 |
|
| accent2可为空 | string | 获取或初始化第二种主题色。 |
|
| content_bg可为空 | string | 获取或初始化内容的背景颜色。 |
|
| panels_bg可为空 | string | 获取或初始化面板的背景颜色。 |
|
| content_text可为空 | string | 获取或初始化内容的文本颜色。 |
|
| text_contrast可为空 | string | 获取或初始化文本的对比色。 |
|
| nav_bg可为空 | string | 获取或初始化导航的背景颜色。 |
|
| nav_text可为空 | string | 获取或初始化导航的文本颜色。 |
|
| portal_header_bg可为空 | string | 获取或初始化门户标题的背景颜色。 |
|
| portal_header_text可为空 | string | 获取或初始化门户标题的文本颜色。 |
|
| toolbar_bg可为空 | string | 获取或初始化工具栏的背景颜色。 |
|
| toolbar_text可为空 | string | 获取或初始化工具栏的文本颜色。 |
|
| toolbar_height可为空 | string | 获取或初始化工具栏的高度。 |
|
| portal | PortalVariablesViewModel |
表示门户主题变量的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| advanced | Boolean | 是否打开高级设置。 |
|
| primaryNav | PrimaryNavVariablesViewModel | ||
| secondaryNav | SecondaryNavVariablesViewModel | ||
| workspace | WorkspaceVariablesViewModel | ||
| sidebar | SidebarVariablesViewModel |
表示门户主要导航主题变量的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| portal_pri_nav_bg可为空 | string | 获取或初始化主导航的背景颜色。 |
|
| portal_pri_nav_text可为空 | string | 获取或初始化主导航的前景色。 |
|
| portal_pri_nav_bg_active可为空 | string | 获取或初始化主导航的突出显示背景颜色。 |
|
| portal_pri_nav_text_active可为空 | string | 获取或初始化主导航的突出显示前景色。 |
表示门户的二级导航主题变量的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| portal_sec_nav_bg可为空 | string | 获取或初始化辅助导航的背景颜色。 |
|
| portal_sec_nav_text可为空 | string | 获取或初始化辅助导航的主要前景颜色。 |
|
| portal_sec_nav_icon可为空 | string | 获取或初始化辅助导航的图标颜色。 |
|
| portal_sec_nav_bg_active可为空 | string | 获取或初始化辅助导航的突出显示背景颜色。 |
|
| portal_sec_nav_text_active可为空 | string | 获取或初始化辅助导航的主要突出显示前景颜色。 |
|
| portal_sec_nav_icon_active可为空 | string | 获取或初始化辅助导航的突出显示图标颜色。 |
|
| portal_sec_nav_heading_text可为空 | string | 获取或初始化辅助导航的标题文本颜色。 |
表示门户工作区主题变量的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| portal_ws_bg可为空 | string | 获取或初始化工作区的背景颜色。 |
|
| portal_ws_text可为空 | string | 获取或初始化工作区的前景色。 |
|
| portal_ws_bg_active可为空 | string | 获取或初始化工作区的突出显示背景颜色。 |
|
| portal_ws_text_active可为空 | string | 获取或初始化工作区的突出显示前景颜色。 |
|
| portal_ws_heading_text可为空 | string | 获取或初始化工作区的标题文本颜色。 |
表示门户侧边栏主题变量的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| portal_sidebar_bg可为空 | string | 获取或初始化侧边栏的背景颜色。 |
|
| portal_sidebar_text可为空 | string | 获取或初始化侧边栏的前景色。 |
|
| portal_sidebar_text_active可为空 | string | 获取或初始化侧边栏的突出显示前景颜色。 |
|
| portal_sidebar_heading_text可为空 | string | 获取或初始化侧边栏的标题文本颜色。 |
服务器插件错误
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code可为空 | string | 错误代码 | |
| message可为空 | string | 错误信息 | |
| context可为空 | string | 错误上下文 | |
| innerError | ServerPluginError | ||
| extensions可为空 | any | 扩展结果 |
表示创建或更新自定义主题的响应模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| sessionId可为空 | string | 获取或设置创建/更新操作的会话标识符。 |
表示创建自定义主题的请求模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| displayName可为空 | string | 获取或设置自定义主题的显示名称。 | |
| variables | ThemeVariablesViewModel |
表示主题构建器状态的视图模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| statusEnum | ThemeBuilderStatusEnumViewModel | ||
| description可为空 | string | 当前状态的描述。 | |
| errorCode可为空 | string | 如果状态失败则显示错误代码。 | |
| documentId可为空 | string | 与主题相关的文档标识符。 | |
| progress | any | 主题构建过程的进度百分比。 |
Enum:
RUNNINGSUCCESSFAILED表示主题生成器的可能状态。
* RUNNING - 0 - 主题生成器当前正在运行。
* SUCCESS - 1 - 主题构建过程成功。
* FAILED - 2 - 主题构建过程失败。
表示升级自定义主题的响应模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| version可为空 | string | 获取或设置升级主题的版本。 | |
| sessionId可为空 | string | 获取或设置升级的会话标识符。 |
表示保存自定义主题的请求模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| comment可为空 | string | 获取或设置与自定义主题相关的注释。 | |
| variables | ThemeVariablesViewModel | ||
| sessionId可为空 | string | 获取或设置自定义主题的会话标识符。 |